BBS Toolkit

home *** CD-ROM | disk | FTP | other *** search

/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sellem12.zip / SELL'EM.DOC < prev next >

Wrap

Text File | 1992-07-08 | 16KB | 382 lines

************************************************************** * * * SELL'EM.EXE v1.2 Copyright (c) 1992 * * * * Sagerquist Micro Engineering * * * * 1414 W. Kerrick Street * * Lancaster, Ca. 93534 * * Data (805) 723-6908 * * * ************************************************************** DESCRIPTION ----------- SELL'EM.EXE is a BBS Advertisement Trap Door program. There may be up to 20 defined database files where the ads can be placed. Within each database, up to 50 entries (records) may be placed by the BBS callers or the SysOp for all callers to view. SYNTAX ------ SELL'EM [-(bbstype)] or SELL'EM -COMPRESS EXAMPLES -------- SELL'EM -MH1 SELL'EM -COMPRESS (See section on deleting records) Supported BBS's: Mega/Maxi/MiniHost: -MH1 (DOOR.SYS) Mega/Maxi/MiniHost: -MH2 (DORINFO1.DEF) PcBoard: -PCBOARD (DOOR.SYS) QuickBBS: -QBBS (DORINFO1.DEF) RBBS: -RBBS (DORINFO1.DEF) Remote Access: -RA1 (DOOR.SYS) Remote Access: -RA2 (DORINFO1.DEF) Teleguard: -TELEGUARD (CHAIN.TXT) TGP: -TGP (CHAIN.TXT) Wildcat (v3.0+): -WILDCAT (DOOR.SYS) Wildcat: -CALLINFO (CALLINFO.BBS) World War IV: -WWIV (CHAIN.TXT) Note: The BBS will create its caller definition file, such as DOOR.SYS, DORINFO1.DEF, etc. The data format within these files may be different for each BBS even though the same filename is used for another: DOOR.SYS for MEGAHOST is different than DOOR.SYS for Wildcat. Be sure to use the proper switch. 14 FILES -------- SELL'EM EXE Executable program. SELL'EM DBM Data Base Menu file. SELL'EM DOC Document file. (This file). SELL'EM REG Registration text file. SOFTWARE DAT Sample database file with 3 ads. NAT'LBBS DAT Sample database file with 1 ad. TRAPDOOR BAT Sample batch file for a BBS Trap Door. CALLINFO BBS Sample BBS file. CHAIN TXT Sample BBS file. DOOR SYS Sample BBS file. WC_DOOR SYS Sample BBS file (WILDCAT 3.0's version. Rename to DOOR.SYS). DORINFO1 DEF Sample BBS file. RBBSINFO DEF Sample BBS file (RBBS's format. Rename to DORINFO1.DEF). TEST BAT Batch file for initial testing. SETUP ----- Create a separate subdirectory for SELL'EM and all of its associated files, and place them here. With an ASCII text editor, edit SELL'EM.DBM. This is where your database names and their file names are defined. A menu list may appear like this: Shareware: I B M Software;SOFTWARE.DAT Computers and Equipment;COMP.DAT BBS Listing - Local;LOCALBBS.DAT BBS Listing - National;NAT'LBBS.DAT Automotive: Cars for Sale;SELLCAR.DAT Real Estate;REALEST.DAT Home Services;SERVICES.DAT Garage Sales;GARAGE.DAT The menu item, as it will be displayed to the BBS caller has a maximum length of 25 characters. If you accidentally exceed 25 characters, it will be cut short. The semicolon ; separates the menu name from the filename that will hold its data. This filename may contain a path. Without a path, SELL'EM will look for the file in the default directory (recommended method). DOS standards must be met when deciding on a filename ie: maximum 8 character file name, maximum 3 character extension, etc. See your DOS manual for further details. The filename entry (including the path, if necessary) must not exceed 54 characters. Automotive: Engine Repair;CARFIX.DAT └─ 25 characters max ───┘│└───────────────── Up to 54 characters ──────────────┘ │ Place the file name (and path if desired) Mandatory separator ─────┘ immediately after the semi-colon (NO SPACES!!). I believe SELL'EM is best run from a batch file. This allows for the steps necessary for SELL'EM to run properly: 1 - Relocating the appropriate BBS file (DOOR.SYS, etc.) to the subdirectory where SELL'EM is placed. 2 - Changing to that subdirectory. 3 - Make a BBS log file entry, if desired. 4 - Execute SELL'EM. 5 - Changing back to a subdirectory that's safe for BBS operations. Unless your BBS can perform all these functions for you, I recommend the batch file method. Edit the batch file TRAPDOOR.BAT (included in this ZIP package). Rename this batch file to a name that your BBS will recognize, place it where the BBS will find it. Basically, thats it! It will run for you and your callers. SAMPLE BATCH FILE ----------------- @ECHO OFF CLS C: CD C:\BBS\SELL'EM COPY C:\BBS\DATA\DOOR.SYS C:\BBS\SELL'EM > NUL ECHO ******* Entering SELL'EM *******>> C:\BBS\DATA\BBS.LOG SELL'EM -MH1 CD C:\BBS\UPLOADS ON-LINE OPERATION ----------------- SELL'EM will operate in monochrome mode, or ANSI color mode. Either way, the operation is identical. Only the appearance is different. At the DATABASE MENU, (the opening screen), choose a database to view or manipulate. The <ENTER> key, or the <ESC> key will exit back to the BBS. Type the number of the database displayed, and you will begin viewing the records within that database. Once into a database, the menu allows for many choices: [A]dd - - - - - Allows for adding a new advertisement (record). The "Business Card" gets filled first, then the description. The "Description" allows for 8 lines of 33 characters. The time that the ad was placed is displayed with each record. NOTE: Please notice that the name on the "Business Card" need not be the name of the person entering the ad. This allows a caller to place an ad for a friend or neighbor. The actual record in the database file will contain the name of the person who placed the ad along with of the sysop's name. If the ad is profane or offensive, view the database file with an ASCII text editor. You'll find the culprit's name! [D]elete - - - Allows only the "Originator" (the person who placed the ad) or the sysop to delete the record. Actually, the record is only MARKED as deleted. The sysop can view all records marked as DELETED. The "Originator" can view only those DELETED records that he/she placed. Only the sysop can physically REMOVE these records from the database file, explained later. Marking them as "DELETED" inhibits other callers from viewing the record. NOTE: The name of the "Originator" and the sysop are placed into the database record. This way, they can be recognized for the Delete, Undelete and Edit functions. The sysop is the person to whom SELL'EM is registered. [U]ndelete - - Records marked as "DELETED", may be "UNDELETED" by the "Originator" or the sysop only. This restores them to the public view. [E]dit - - - - Allows the "Originator" or the sysop the ability to alter the data in the record. Entering 'E' at the prompt places you into the "EDIT SELECT" mode. The "EDIT SELECT" feature begins at the first item (field) of the ad, the business name. In the ANSI color mode, the EDIT MENU is displayed, then the selected field to edit will flash. In monochrome mode, the field is displayed below the EDIT MENU. You must then choose from the EDIT MENU: ...[E]dit - - - Allows for editing that field. The entire string of characters must be typed. ...[N]ext - - - Move to (select) the next field for possible editing. ...[P]revious - Move to (select) the previous field for possible editing. ...[S]ave - - - Saves the edited record. ...[Q]uit Edit- Exits the edit function. If there were any changes to the record, you are prompted to save. You may save the new data, or restore the old data. [N]ext - - - - Allows for viewing the next record. All records loaded from the database file are numbered. Just below the address on the business card, there's a number like this: "03 of 15" meaning record 3 of 15 available records. [P]revious - - Allows for viewing the previous record. [S]earch - - - Allows for searching for a particular string of characters from the record. This function opens a small menu while its searching the active records: ...[N]ext - - - If a record is found, the search pauses, and displays this record. Use this function to continue searching the remainder of the records (view the next one). ...[S]earch - - This allows for typing in a new string of characters String to search for. The search begins at the first record. If the search does not find the string requested, the function just exits, returning control where you started. ...[Q]uit - - - Stops the search at the current record. [C]hange Database Returns to the Database Menu, to allow viewing another database of advertisements. <ENTER> or <ESC> performs the same task. [Q]uit - - - - Exits program back to the BBS, skipping the Database Menu. REMOVING RECORDS ---------------- When the command line switch "-COMPRESS" is invoked, all the database files are searched. The records marked "DELETED" are physically removed from the files. The command looks like this: SELL'EM -COMPRESS Place this command into your BBS event batch file, and your databases of advertisements will maintain themselves. As a sysop, you might need to prune it occasionally. "Originators" of the ads might forget about them. TECHNICAL --------- SELL'EM.EXE performs its own COM port I/O, no redirection programs are required. COM1 through COM4 are supported. Comm port functions include interrupt driven, buffered input and output. If installed, the 16550 UART's 16 character FIFO buffer is supported for faster transmission speed. Works well with earlier UARTs, also. Carrier Detect is monitored. If a caller disconnects (hangs up) the phone line, SELL'EM will automatically exit, and return to the BBS. The BBS is expected to then perform its own reset. User input time is monitored. A caller has two minutes (120 seconds) to read the advertisement, or make a menu choice. Basically, the user must strike a key at least once every 120 seconds or SELL'EM will exit to the BBS. Incomming characters are checked for error conditions. If a FRAMING error, PARITY error, or DATA OVERRUN error occurs, SELL'EM.EXE will recognize the error and exit to the BBS. On exit of SELL'EM, ERRORLEVELs are returned. Your batch file can check the ERRORLEVEL and determine what has happened. The following is a list of SELL'EM's ERRORLEVELs and their meaning: ERRORLEVEL 0 Normal exit from normal operation. ERRORLEVEL 5 Normal exit from user BREAK. ERRORLEVEL 10 COMPRESS function performed successfully. ERRORLEVEL 15 Error exit: Keyboard time out. No user input for 120 seconds. ERRORLEVEL 20 Error exit: Carrier Lost. Telephone line was disconnected. ERRORLEVEL 25 Error exit: Incomming character framing error. ERRORLEVEL 26 Error exit: Incomming character parity Error. ERRORLEVEL 27 Error exit: UART Receive Data Register overrun. ERRORLEVEL 30 Error exit: Error on the command line. ERRORLEVEL 40 Error exit: Memory allocation: out of "HEAP" memory. ERRORLEVEL 90 Error exit: Unsupported COM port. COM1: through COM4: only. ERRORLEVEL 100 Error exit: Unable to read the BBS file. ERRORLEVEL 110 Error exit: Unable to read SELL'EM.DBM, the database menu file. ERRORLEVEL 120 Error exit: Unable to open or write to the temporary files used in the -COMPRESS feature. The best way to check for ERRORLEVELs is through a batch file. Add a line like the one below in the batch file that calls SELL'EM: IF ERRORLEVEL 100 IF NOT ERRORLEVEL 101 ECHO *** SELL'EM cannot find the BBS file! >> C:\BBS\DATA\BBS.LOG Review your DOS manual for more information on ERRORLEVELs. REGISTRATION ------------ SELL'EM.EXE is not public domain, but Shareware. You are granted a limited license to operate this program for a test period of 30 days. Completing this test period, if you decide to continue its use, you must register with the programmer. The registration fee is $15.00. Make a check or money order payable to: Sagerquist Micro Engineering 1414 W. Kerrick St. Lancaster, Ca. 93534 BBS: (805) 723-6908 Payment is a one time investment which allows you all further revisions at no extra expense. Registration of SELL'EM will increase its usefulness for you and your BBS callers. The database menu will expand from four to a maximum of twenty! The available records will expand from five to a maximum of fifty! The credit banner stating "Unregistered" you see on exit will go away. Please distribute this program, i.e. place it in your communications program download area for others to evaluate and use. Your comments on this program are gladly accepted (requested, actually) at the data number above. Please use the BBS as our communication vehicle. I will gladly respond to all comments through the BBS. DISCLAIMER ---------- This program is distributed as is. No warranty, either expressed or implied is offered and the programmer is not responsible for any damages or expenses that may occur through the use of this program. The user shall determine its suitability. Extensive testing has been performed and every effort has been made to ensure satisfactory performance prior to release. Please communicate any difficulties with the programmer through the BBS at (805) 723-6908. CREDITS ------- Many thanks to Mr. Jeff Silks of California City, Ca. who tested every function of SELL'EM.EXE more thoroughly than I thought possible. The direction and suggestions he gave were above and beyond anything I could have asked for, and SELL'EM.EXE is a better program to show for it. Thanks, Jeff! I owe you one! Many thanks to Mr. Bill Duffy of Indio, Ca., who brought a compat- ability problem to my attention. Mustang Software's WILDCAT! BBS version 3.0 now uses DOOR.SYS rather than CALLINFO.BBS, but in a different format. Thanks to his persistence, SELL'EM now works well with WILDCAT! v3.0 and earlier versions. Thanks, Bill! HISTORY ------- 07/08/92 - Version 1.2 - Comm port routines overhauled. Now supports the 16550 UART's 16 character FIFO buffer as well as earlier UARTs. Input and output are now both buffered and interrupt driven. More thorough error checking now takes place. Unregistered, the evaluating sysop's available databases is increased from 2 to 4. After registration, up to 20 databases may be defined. In the search function, the record number is included in the search. If the search string is "14", all records are searched for the two characters together "14". It still may not go directly to record 14. Revised for compatability with RBBS v17 and its DORINFO1.DEF format. 06/15/92 - Version 1.1 - Revised for compatability with WILDCAT! v3.0 and its DOOR.SYS format. 03/28/92 - Version 1.0 - First release, awaiting comments and suggestions.